Update product

curl --request PUT \
  --url https://firespark.cloud/api/integrations/v1/menus/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {
    "en_us": "Example"
  },
  "description": {
    "en_us": "Example"
  },
  "image_url": "<string>",
  "cms_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bundled_items": [
    {}
  ],
  "pricing": {},
  "availability": {},
  "metadata": {}
}
'

import requests

url = "https://firespark.cloud/api/integrations/v1/menus/products/{id}"

payload = {
    "name": { "en_us": "Example" },
    "description": { "en_us": "Example" },
    "image_url": "<string>",
    "cms_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bundled_items": [{}],
    "pricing": {},
    "availability": {},
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: {en_us: 'Example'},
    description: {en_us: 'Example'},
    image_url: '<string>',
    cms_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    bundled_items: [{}],
    pricing: {},
    availability: {},
    metadata: {}
  })
};

fetch('https://firespark.cloud/api/integrations/v1/menus/products/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://firespark.cloud/api/integrations/v1/menus/products/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => [
        'en_us' => 'Example'
    ],
    'description' => [
        'en_us' => 'Example'
    ],
    'image_url' => '<string>',
    'cms_template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'bundled_items' => [
        [
                
        ]
    ],
    'pricing' => [
        
    ],
    'availability' => [
        
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://firespark.cloud/api/integrations/v1/menus/products/{id}"

	payload := strings.NewReader("{\n  \"name\": {\n    \"en_us\": \"Example\"\n  },\n  \"description\": {\n    \"en_us\": \"Example\"\n  },\n  \"image_url\": \"<string>\",\n  \"cms_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"bundled_items\": [\n    {}\n  ],\n  \"pricing\": {},\n  \"availability\": {},\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://firespark.cloud/api/integrations/v1/menus/products/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": {\n    \"en_us\": \"Example\"\n  },\n  \"description\": {\n    \"en_us\": \"Example\"\n  },\n  \"image_url\": \"<string>\",\n  \"cms_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"bundled_items\": [\n    {}\n  ],\n  \"pricing\": {},\n  \"availability\": {},\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://firespark.cloud/api/integrations/v1/menus/products/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": {\n    \"en_us\": \"Example\"\n  },\n  \"description\": {\n    \"en_us\": \"Example\"\n  },\n  \"image_url\": \"<string>\",\n  \"cms_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"bundled_items\": [\n    {}\n  ],\n  \"pricing\": {},\n  \"availability\": {},\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": {
      "en_us": "Example"
    },
    "pricing": {},
    "availability": {},
    "description": {
      "en_us": "Example"
    },
    "image_url": "<string>",
    "cms_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bundled_items": [
      {}
    ],
    "labels": [],
    "tags": {},
    "metadata": {}
  }
}

PUT

menus

products

{id}

Update product

curl --request PUT \
  --url https://firespark.cloud/api/integrations/v1/menus/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {
    "en_us": "Example"
  },
  "description": {
    "en_us": "Example"
  },
  "image_url": "<string>",
  "cms_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bundled_items": [
    {}
  ],
  "pricing": {},
  "availability": {},
  "metadata": {}
}
'

import requests

url = "https://firespark.cloud/api/integrations/v1/menus/products/{id}"

payload = {
    "name": { "en_us": "Example" },
    "description": { "en_us": "Example" },
    "image_url": "<string>",
    "cms_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bundled_items": [{}],
    "pricing": {},
    "availability": {},
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: {en_us: 'Example'},
    description: {en_us: 'Example'},
    image_url: '<string>',
    cms_template_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    bundled_items: [{}],
    pricing: {},
    availability: {},
    metadata: {}
  })
};

fetch('https://firespark.cloud/api/integrations/v1/menus/products/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://firespark.cloud/api/integrations/v1/menus/products/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => [
        'en_us' => 'Example'
    ],
    'description' => [
        'en_us' => 'Example'
    ],
    'image_url' => '<string>',
    'cms_template_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'bundled_items' => [
        [
                
        ]
    ],
    'pricing' => [
        
    ],
    'availability' => [
        
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://firespark.cloud/api/integrations/v1/menus/products/{id}"

	payload := strings.NewReader("{\n  \"name\": {\n    \"en_us\": \"Example\"\n  },\n  \"description\": {\n    \"en_us\": \"Example\"\n  },\n  \"image_url\": \"<string>\",\n  \"cms_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"bundled_items\": [\n    {}\n  ],\n  \"pricing\": {},\n  \"availability\": {},\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://firespark.cloud/api/integrations/v1/menus/products/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": {\n    \"en_us\": \"Example\"\n  },\n  \"description\": {\n    \"en_us\": \"Example\"\n  },\n  \"image_url\": \"<string>\",\n  \"cms_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"bundled_items\": [\n    {}\n  ],\n  \"pricing\": {},\n  \"availability\": {},\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://firespark.cloud/api/integrations/v1/menus/products/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": {\n    \"en_us\": \"Example\"\n  },\n  \"description\": {\n    \"en_us\": \"Example\"\n  },\n  \"image_url\": \"<string>\",\n  \"cms_template_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"bundled_items\": [\n    {}\n  ],\n  \"pricing\": {},\n  \"availability\": {},\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "<string>",
    "name": {
      "en_us": "Example"
    },
    "pricing": {},
    "availability": {},
    "description": {
      "en_us": "Example"
    },
    "image_url": "<string>",
    "cms_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bundled_items": [
      {}
    ],
    "labels": [],
    "tags": {},
    "metadata": {}
  }
}

Updates a single product within a composed menu. Use this endpoint when your POS or RMS pushes item-level changes — pricing, availability, or bundled items — without replacing the entire menu payload. The request body uses the same menu product shape as products in Upsert menus. Send only the fields you want to change; omitted fields keep their current values.

Requires an access token with the menus:write scope. See Token to obtain a token.

Path parameters

Parameter	Description
`id`	External product identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters.

Query parameters

Parameter	Required	Description
`brand_id`	No	External brand identifier. Omit or pass `__ANY__` for the merchant-wide default. When set, scope the update to menus for this brand only.
`store_id`	No	External store identifier. Scope the update to menus for this store. Omit or pass `__ANY__` for the merchant-wide default.
`channel_id`	No	External channel identifier. Scope the update to menus for this channel. Omit or pass `__ANY__` for all channels.
`fulfillment_id`	No	External fulfillment identifier. When set, scope the update to menus for that fulfillment type only. Omit to update the product in every fulfillment type within the resolved store and channel scope. See List fulfillment.
`menu_id`	No	External menu identifier. Scope the update to one composed menu when several menus share the same store, channel, and fulfillment scope — for example lunch and dinner schedules. Omit to update the product in every matching menu.

Combine scope query parameters when a product needs different pricing or availability in one selling context — the same pattern as scoped menu upserts. Each composed menu is keyed by fulfillment_id + store_id + channel_id + brand_id + menu.id; see Menu sync.

Request body

Same shape as a product in the products array on Upsert menus. Every field is optional on update; omitted fields keep their current values. The product id is set in the path parameter — omit it from the request body.

products

Each product in the request body:

Field	Required	Type	Description
`id`	Yes	string	External product identifier. Set via the path parameter — omit from the request body.
`name`	Yes	object	Localized display name keyed by locale (for example `en_us`).
`description`	No	object \| null	Localized description. `null` when omitted.
`image_url`	No	string	Product image URL. `null` when omitted.
`bundled_items`	No	array	Items included in a bundle or combo. Defaults to `[]`.
`pricing`	Yes	object	Price, tax, quantity limits, and modifier configuration. See pricing.
`availability`	Yes	object	Product availability. See fields below.
`labels`	No	string[]	Short labels for Dashboard filters and quick selection. At most 64 strings (1–128 characters each). Defaults to `[]`.
`tags`	No	object	Key/value tags for advanced custom rules. Values may be boolean, string, or number. Defaults to `{}`. See Custom rules.
`metadata`	No	object	Partner-specific metadata. Defaults to `{}`.

Each availability object:

Field	Required	Type	Description
`status`	Yes	string	`AVAILABLE`, `UNAVAILABLE`, or `OUT_OF_STOCK`.
`schedules`	No	array \| null	Schedule entries with `day_of_week` and `periods`. `null` when there is no schedule restriction.
`out_of_stock_until`	No	string	Optional ISO 8601 datetime when the product returns to stock.

Each bundled_items entry:

Field	Required	Type	Description
`id`	Yes	string	External identifier of the bundled product.
`refund_price`	Yes	number	Refund amount when the customer removes this item from the bundle. ≥ 0.
`included_quantity`	Yes	number	Units included by default. ≥ 0.

Example product

{
  "id": "burger-classic",
  "name": { "en_us": "Classic burger" },
  "description": { "en_us": "Angus beef patty with lettuce and tomato." },
  "image_url": "https://cdn.example.com/burger-classic.jpg",
  "bundled_items": [],
  "pricing": {
    "minimum_quantity": 1,
    "maximum_quantity": 10,
    "is_tax_inclusive": true,
    "tax_rate": 0.15,
    "price": 12.99,
    "anchor_price": 14.99,
    "anchor_price_percentage": 0.13,
    "modifiers": [],
    "modifier_group_ids": ["choose-drink"]
  },
  "availability": {
    "status": "AVAILABLE",
    "schedules": null,
    "out_of_stock_until": null
  },
  "metadata": {}
}

pricing

Product pricing in the request body:

Field	Required	Type	Description
`minimum_quantity`	Yes	number	Minimum units per order. ≥ 0.
`maximum_quantity`	Yes	number	Maximum units per order. 0–1,000,000.
`is_tax_inclusive`	Yes	boolean	Whether `price` includes tax.
`tax_rate`	Yes	number	Tax rate as a decimal (for example `0.15` for 15%). 0–1.
`price`	Yes	number	List price. ≥ 0.
`anchor_price`	Yes	number	Reference price for strikethrough or comparison. ≥ 0.
`anchor_price_percentage`	Yes	number	Discount shown relative to `anchor_price`. 0–1.
`modifiers`	No	array	Per-group pricing and selection overrides. Defaults to `[]`.
`modifier_group_ids`	No	array	External modifier group identifiers attached to this product. Defaults to `[]`.

Each object in modifiers configures one modifier group referenced in modifier_group_ids. It accepts the same pricing fields as the parent product, plus modifier-specific fields:

Field	Required	Type	Description
`modifier_group_id`	Yes	string	External modifier group identifier. Must match a group in `modifier_group_ids`.
`minimum_quantity`	Yes	number	Minimum units per order for modifiers in this group. ≥ 0.
`maximum_quantity`	Yes	number	Maximum units per order for modifiers in this group. 0–1,000,000.
`is_tax_inclusive`	Yes	boolean	Whether `price` includes tax for modifiers in this group.
`tax_rate`	Yes	number	Tax rate as a decimal (for example `0.15` for 15%). 0–1.
`price`	Yes	number	List price for modifiers in this group. ≥ 0.
`anchor_price`	Yes	number	Reference price for strikethrough or comparison. ≥ 0.
`anchor_price_percentage`	Yes	number	Discount shown relative to `anchor_price`. 0–1.
`default_quantity`	Yes	number	Pre-selected quantity for modifiers in this group. ≥ 0.
`charge_above_quantity`	No	number	Free selections before charges apply. Optional.
`display_type`	No	string	How modifiers render in the UI: `RADIO`, `CHECKBOX`, or `QUANTITY`. Optional.

Example modifiers entry

{
  "modifier_group_id": "choose-drink",
  "minimum_quantity": 0,
  "maximum_quantity": 1,
  "is_tax_inclusive": true,
  "tax_rate": 0.15,
  "price": 0,
  "anchor_price": 0,
  "anchor_price_percentage": 0,
  "default_quantity": 1,
  "charge_above_quantity": 0,
  "display_type": "RADIO"
}

Response

Returns the updated product in data — the same shape as a product in List menus, including id, name, pricing, availability, bundled_items, and metadata.

Error responses

Status	Description
`400`	Validation error.
`401`	Missing or invalid access token.
`403`	Token does not include the `menus:write` scope.
`404`	No product with this `id` exists in the menu.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.